From 3fb15acf6de0c1f65612a28a7beff776bf3afcc0 Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Mon, 9 Apr 2018 21:27:34 +0100 Subject: [PATCH] Add a references to the links key in the manifest docs Fixes #4975 --- src/doc/src/reference/manifest.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index ebc539dc3..334230d42 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -45,6 +45,21 @@ building native code. More information can be found in the build script build = "build.rs" ``` +#### The `links` field (optional) + +This fields specifies the name of a native library that is being linked to. +More information can be found in the [`links`][links] section of the build +script guide. + +[links]: reference/build-scripts.html#the-links-manifest-key + +```toml +[package] +# ... +links = "foo" +build = "build.rs" +``` + #### The `documentation` field (optional) This field specifies a URL to a website hosting the crate's documentation. -- 2.30.2